<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<STYLE>body{margin:3em;} pre{background:#ffc;}</STYLE>
<META NAME="generator" CONTENT="http://txt2tags.org">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
<TITLE>TXT2TAGS</TITLE>
</HEAD><BODY BGCOLOR="white" TEXT="black">
<CENTER>
<H1>TXT2TAGS</H1>
<FONT SIZE="4">Ago, 2010</FONT>
</CENTER>

<P></P>
<HR NOSHADE SIZE=1>
<P></P>

  <UL>
  <LI><A HREF="#nome">NOME</A>
  <LI><A HREF="#sinopse">SINOPSE</A>
  <LI><A HREF="#descricao">DESCRIÇÃO</A>
  <LI><A HREF="#sintaxe">SINTAXE</A>
  <LI><A HREF="#opcoes">OPÇÕES</A>
  <LI><A HREF="#fonte">ARQUIVO FONTE</A>
  <LI><A HREF="#config">CONFIGURAÇÕES</A>
  <LI><A HREF="#comandos">COMANDOS</A>
  <LI><A HREF="#macros">MACROS</A>
  <LI><A HREF="#exemplos">EXEMPLOS</A>
  <LI><A HREF="#arquivos">ARQUIVOS</A>
  <LI><A HREF="#ambiente">AMBIENTE</A>
  <LI><A HREF="#autor">AUTOR</A>
  <LI><A HREF="#bugs">BUGS</A>
  <LI><A HREF="#copyright">COPYRIGHT</A>
  </UL>

<P></P>
<HR NOSHADE SIZE=1>
<P></P>

<A NAME="nome"></A>
<H1>NOME</H1>

<P>
txt2tags - ferramenta para formatar e converter textos
</P>

<A NAME="sinopse"></A>
<H1>SINOPSE</H1>

<P>
<B>txt2tags</B> [<I>opções</I>] [<I>ARQUIVO</I>...]
</P>

<A NAME="descricao"></A>
<H1>DESCRIÇÃO</H1>

<P>
O <B>txt2tags</B> lê um arquivo texto com poucas marcações e o converte para:
<I>ASCII Art</I>,
<I>AsciiDoc</I>,
<I>Creole</I>,
<I>DocBook</I>,
<I>DokuWiki</I>,
<I>Google Code Wiki</I>,
<I>HTML</I>,
<I>LaTeX</I>,
<I>Lout</I>,
<I>MagicPoint</I>,
<I>Man page</I>,
<I>MoinMoin</I>,
<I>PageMaker</I>,
<I>Plain Text</I>,
<I>PmWiki</I>,
<I>SGML</I>,
<I>Wikipedia</I> e
<I>XHTML</I>.
</P>
<P>
Esta página de manual foi criada pelo <B>txt2tags</B> a partir de um arquivo de texto. Este mesmo arquivo de texto também é convertido para HTML e colocado no site do programa para consulta.
</P>
<P>
UM arquivo fonte, VÁRIOS destinos - <A HREF="http://txt2tags.org">http://txt2tags.org</A>
</P>

<A NAME="sintaxe"></A>
<H1>SINTAXE</H1>

<PRE>
  Cabeçalhos          As 3 primeiras linhas do arquivo fonte
  Título              = palavras =
  Título numerado     + palavras +
  Comentário          % comentários
  Linha de separação  -----------------------...
  Linha destacada     =======================...
  Imagem              [arquivo.jpg]
  Link                [nome url]
  
  Negrito             **palavras**
  Itálico             //palavras//
  Sublinhado          __palavras__
  Riscado             --palavras--
  Monoespaçado        ``palavras``
  Texto protegido     ""palavras""
  Texto com tags      ''palavras''
  
  Parágrafo           palavras
  Citação             &lt;TAB&gt;palavras
  Lista               - palavras
  Lista numerada      + palavras
  Lista de definição  : palavras
  Tabela              | cel1 | cel2 | cel3...
  
  Linha formatada     ``` palavras
  Linha protegida     """ palavras
  Linha com tags      ''' palavras
  
  Área formatada      ```
                      linhas
                      ```
  Área protegida      """
                      linhas
                      """
  Área com tags       '''
                      linhas
                      '''
</PRE>

<A NAME="opcoes"></A>
<H1>OPÇÕES</H1>

<DL>
<DT>    <B>--art-chars</B>=<I>STRING</I></DT><DD>
Define <I>STRING</I> como a lista de caracteres usados para fazer os enfeites do ASCII Art, nesta ordem: canto, borda, lado, linha1, linha2, nível2, nível3, nível4, nível5. O valor padrão da string é +-|-==-^". Esta opção é utilizada somente pelo formato ASCII Art.
<P></P>
<DT><B>-C</B>, <B>--config-file</B>=<I>ARQUIVO</I></DT><DD>
Lê a configuração a partir do arquivo externo <I>ARQUIVO</I>. A configuração deve estar no formato <I>%!nome:valor</I>. Veja o tópico <A HREF="#config">CONFIGURAÇÕES</A> para mais detalhes.
<P></P>
<DT>    <B>--css-sugar</B></DT><DD>
Prepara o código HTML/XHTML para ser usado com arquivos CSS. Os atributos das tags são removidos, tags de formatação são evitadas, o cabeçalho é composto pelas tags H1, H2 e H3, novos DIVs são criados: <I>#header</I>, <I>#body</I>, <I>.toc</I>.
<P></P>
<DT>    <B>--css-inside</B></DT><DD>
Insere o conteúdo do arquivo CSS no cabeçalho do documento HTML/XHTML. Use <CODE>--style</CODE> para indicar o arquivo CSS a ser lido.
<P></P>
<DT>    <B>--dump-config</B></DT><DD>
Exibe todas as configurações encontradas e sai.
<P></P>
<DT>    <B>--dump-source</B></DT><DD>
Exibe os fontes do documento, com os arquivos incluídos (<CODE>%!include</CODE>) expandidos.
<P></P>
<DT>    <B>--encoding</B>=<I>CÓDIGO</I></DT><DD>
Define a codificação do arquivo para <I>CÓDIGO</I>. Alguns exemplos são UTF-8 e iso-8859-1.
<P></P>
<DT>    <B>--gui</B></DT><DD>
Carrega a interface gráfica (Tk).
<P></P>
<DT><B>-h</B>, <B>--help</B></DT><DD>
Exibe o texto de ajuda e sai.
<P></P>
<DT><B>-H</B>, <B>--no-headers</B></DT><DD>
Suprime os cabeçalhos e o rodapé do documento. Apenas o Corpo do documento será mostrado.
<P></P>
<DT>    <B>--headers</B></DT><DD>
Exibe os cabeçalhos e o rodapé no documento. Esta opção é usada por padrão.
<P></P>
<DT>    <B>--height</B>=<I>N</I></DT><DD>
Define a altura da saída para <I>N</I> linhas. Esta opção é utilizada somente pelo formato ASCII Art, quando também utilizada a opção <CODE>--slides</CODE>.
<P></P>
<DT><B>-i</B>, <B>--infile</B>=<I>ARQUIVO</I></DT><DD>
Define <I>ARQUIVO</I> como arquivo fonte. Use '-' para ler os dados de STDIN.
<P></P>
<DT>    <B>--mask-email</B></DT><DD>
Esconde os e-mails dos robôs de SPAM. Os pontos e o @ são removidos. O endereço foo@bar.com vira &lt;foo (a) bar com&gt;.
<P></P>
<DT><B>-n</B>, <B>--enum-title</B></DT><DD>
Enumera todos os títulos automaticamente, nos formatos 1, 1.1, 1.1.1, ...
<P></P>
<DT>    <B>--no-dump-config</B></DT><DD>
Cancela a ação <CODE>--dump-config</CODE>.
<P></P>
<DT>    <B>--no-dump-source</B></DT><DD>
Cancela a ação <CODE>--dump-source</CODE>.
<P></P>
<DT>    <B>--no-encoding</B></DT><DD>
Remove a configuração de codificação.
<P></P>
<DT>    <B>--no-enum-title</B></DT><DD>
Desativa a numeração automática de títulos.
<P></P>
<DT>    <B>--no-infile</B></DT><DD>
Remove as definições anteriores do arquivo fonte.
<P></P>
<DT>    <B>--no-targets</B></DT><DD>
Cancela a ação <CODE>--targets</CODE>.
<P></P>
<DT>    <B>--no-mask-email</B></DT><DD>
Desativa o disfarce de emails.
<P></P>
<DT>    <B>--no-outfile</B></DT><DD>
Remove as definições anteriores sobre o arquivo de destino.
<P></P>
<DT>    <B>--no-quiet</B></DT><DD>
Mostras as mensagens, desativando a opção <CODE>--quiet</CODE>.
<P></P>
<DT>    <B>--no-rc</B></DT><DD>
Não lê o arquivo configuração do usuário em ~/.txt2tagsrc.
<P></P>
<DT>    <B>--no-slides</B></DT><DD>
Desliga os slides.
<P></P>
<DT>    <B>--no-style</B></DT><DD>
Remove todas as configurações de estilo.
<P></P>
<DT>    <B>--no-toc</B></DT><DD>
Remove o Sumário automático.
<P></P>
<DT>    <B>--no-toc-only</B></DT><DD>
Desativa a opção <CODE>--toc-only</CODE>.
<P></P>
<DT><B>-o</B>, <B>--outfile</B>=<I>ARQUIVO</I></DT><DD>
Define <I>ARQUIVO</I> como arquivo de destino. Use '-' para mandar o resultado para STDOUT.
<P></P>
<DT><B>-q</B>, <B>--quiet</B></DT><DD>
Modo silencioso, não mostra nada na saída, exceto os erros.
<P></P>
<DT>    <B>--rc</B></DT><DD>
Lê a configuração do usuário em ~/.txt2tagsrc. Esta opção é usada por padrão.
<P></P>
<DT>    <B>--slides</B></DT><DD>
Formata a saída como uma apresentação de slides. Esta opção é utilizada somente pelo formato ASCII Art.
<P></P>
<DT>    <B>--style</B>=<I>ARQUIVO</I></DT><DD>
Utiliza <I>ARQUIVO</I> como estilo do documento. É usado para incluir arquivos CSS em documentos HTML, e pacotes para o LaTeX. Esta opção pode ser usada mais de uma vez caso você precise incluir dois ou mais arquivos.
<P></P>
<DT><B>-t</B>, <B>--target</B>=<I>FORMATO</I></DT><DD>
Define o formato do documento de destino. Alguns formatos populares são: <I>html</I>, <I>xhtml</I>, <I>tex</I>, <I>man</I>, <I>txt</I>. Use a opção <CODE>--targets</CODE> para ver a lista completa com todos os formatos disponíveis.
<P></P>
<DT>    <B>--targets</B></DT><DD>
Mostra a lista completa de todos os formatos disponíveis e sai.
<P></P>
<DT>    <B>--toc</B></DT><DD>
Inclui um Sumário automático (Table of Contents) no documento de destino, entre o cabeçalho e o corpo. Você também pode indicar onde o Sumário deve ser colocado, usando a macro <CODE>%%TOC</CODE>.
<P></P>
<DT>    <B>--toc-level</B>=<I>N</I></DT><DD>
Define o nível máximo (profundidade) do Sumário para <I>N</I>. Os títulos abaixo do nível <I>N</I> não serão incluídos no Sumário.
<P></P>
<DT>    <B>--toc-only</B></DT><DD>
Exibe o Sumário do documento e sai.
<P></P>
<DT><B>-v</B>, <B>--verbose</B></DT><DD>
Exibe mensagens informativas durante a conversão. Utilize-a duas ou mais vezes na linha de comando para aumentar o número de mensagens a serem mostradas.
<P></P>
<DT><B>-V</B>, <B>--version</B></DT><DD>
Exibe a versão do programa e sai.
<P></P>
<DT>    <B>--width</B>=<I>N</I></DT><DD>
Define a largura da saída para <I>N</I> colunas. Esta opção é utilizada somente pelo formato ASCII Art.
</DL>

<A NAME="fonte"></A>
<H1>ARQUIVO FONTE</H1>

<P>
Um arquivo fonte do <B>txt2tags</B> geralmente usa a extensão <I>.t2t</I>, como por exemplo: <CODE>trabalho.t2t</CODE>. Você pode ter três áreas distintas em seus fontes:
</P>

<DL>
<DT><B>Cabeçalho</B></DT><DD>
As primeiras três linhas. São usadas para identificação do documento, como título, autor, versão e data. Se você não quiser usar cabeçalhos, deixe a primeira linha em branco.
<P></P>
<DT><B>Configuração</B></DT><DD>
Inicia logo após o cabeçalho (4ª ou 2ª linha) e termina quando o Corpo se inicia. Esta área é usada para configurações no formato <CODE>%!nome:valor</CODE>.
<P></P>
<DT><B>Corpo</B></DT><DD>
Começa na primeira linha de texto (que não seja um comentário ou uma configuração) logo após o cabeçalho e vai até o fim do documento. É usada para guardar o conteúdo do documento.
</DL>

<A NAME="config"></A>
<H1>CONFIGURAÇÕES</H1>

<P>
Você pode personalizar o txt2tags usando configurações. Elas são parecidas com as opções de linha de comando e podem ser usadas nos seguintes locais: na área Configuração do seu arquivo fonte, no arquivo <CODE>~/.txt2tagsrc</CODE> ou ainda em um arquivo externo chamado com a opção <CODE>--config-file</CODE>.
</P>

<DL>
<DT><B>%!target</B></DT><DD>
Define o formato de saída, igual faz a opção <CODE>--target</CODE>. Exemplo:

<PRE>
  %!target: html
</PRE>

<P></P>
<DT><B>%!options(target)</B></DT><DD>
Define as opções de cada formato. No valor você deve colocar as opções de linha de comando. Exemplo:

<PRE>
  %!options(html): --toc --toc-level 3 --css-sugar
</PRE>

<P></P>
<DT><B>%!includeconf</B></DT><DD>
Lê as configurações a partir de um arquivo externo, igual faz a opção <CODE>--config-file</CODE>. Exemplo:

<PRE>
  %!includeconf: minhaconfig.t2t
</PRE>

<P></P>
<DT><B>%!style</B></DT><DD>
Define um arquivo de estilos para o documento, igual faz a opção <CODE>--style</CODE>. Pode ser usada várias vezes para definir mais de um arquivo. Exemplo:

<PRE>
  %!style: cores.css
</PRE>

<P></P>
<DT><B>%!encoding</B></DT><DD>
Define a codificação do texto, igual faz a opção <CODE>--encoding</CODE>. Exemplo:

<PRE>
  %!encoding: UTF-8
</PRE>

<P></P>
<DT><B>%!preproc</B></DT><DD>
Filtro de entrada (estilo troque "isso" por "aquilo") usado para alterar o Corpo do documento ANTES do txt2tags processá-lo. Você pode usar as expressões regulares do Python. Exemplo:

<PRE>
  %!preproc:  "FSS"  "Fulano da Silva Sauro"
</PRE>

<P></P>
<DT><B>%!postproc</B></DT><DD>
Filtro de saída (estilo troque "isso" por "aquilo") usado para alterar o documento de saída DEPOIS da conversão feita pelo txt2tags. Você pode usar as expressões regulares do Python. Exemplo:

<PRE>
  %!postproc(html):  "&lt;B&gt;"  "&lt;STRONG&gt;"
</PRE>

</DL>

<P>
Se a mesma configuração for usada mais de uma vez, somente a última será utilizada. As exceções são: options, preproc e postproc, que são cumulativas. Configurações com nomes inválidos serão ignoradas. A ordem de processamento é: <CODE>~/.txt2tagsrc</CODE>, área Configuração do arquivo fonte, opção <CODE>--config-file</CODE>.
</P>

<A NAME="comandos"></A>
<H1>COMANDOS</H1>

<P>
Os comandos são executados durante a conversão do documento. Eles devem ser colocados dentro do Corpo do arquivo fonte.
</P>

<DL>
<DT><B>%!csv: arquivo.csv</B></DT><DD>
Gera uma tabela a partir de um arquivo externo CSV.
<P></P>
<DT><B>%!include: arquivo.t2t</B></DT><DD>
Inclui um arquivo fonte txt2tags no documento.
<P></P>
<DT><B>%!include: ``arquivo.txt``</B></DT><DD>
Inclui um arquivo texto no documento.
<P></P>
<DT><B>%!include: ''arquivo.html''</B></DT><DD>
Inclui um arquivo pronto no documento, ele não é modificado.
</DL>

<A NAME="macros"></A>
<H1>MACROS</H1>

<P>
As macros são úteis para inserir conteúdos dinâmicos em seu documento, como a data atual, por exemplo. Exceto a <CODE>%%toc</CODE>, todas as macros podem ser personalizadas com curingas tipo <CODE>%Y</CODE> e <CODE>%f</CODE>. Veja o Guia do Usuário para saber mais detalhes.
</P>

<DL>
<DT><B>%%date</B></DT><DD>
Insere a data atual. O formato padrão é <CODE>%%date(%Y%m%d)</CODE>, que fica AAAAMMDD.
<P></P>
<DT><B>%%infile</B></DT><DD>
Insere o nome do arquivo fonte. O formato padrão é <CODE>%%infile(%f)</CODE>. Útil para links de rodapé, como <CODE>[Veja os fontes %%infile]</CODE>.
<P></P>
<DT><B>%%mtime</B></DT><DD>
Insere a data de modificação do arquivo fonte. O formato padrão é <CODE>%%date(%Y%m%d)</CODE>, que fica AAAAMMDD.
<P></P>
<DT><B>%%outfile</B></DT><DD>
Insere o nome do arquivo de saída. O formato padrão é <CODE>%%outfile(%f)</CODE>. Útil para mencionar o próprio documento, como em "Este é o arquivo manpage-pt.html".
<P></P>
<DT><B>%%toc</B></DT><DD>
Especifica o lugar onde será colocado o Sumário (Table Of Contents). Você pode utilizá-la em qualquer parte do documento, inclusive mais de uma vez. A opção <CODE>--toc</CODE> também deve ser usada para esta que esta macro funcione.
</DL>

<A NAME="exemplos"></A>
<H1>EXEMPLOS</H1>

<DL>
<DT><CODE>txt2tags -t html arquivo.t2t</CODE></DT><DD>
<P></P>
Converte para HTML, gravando o resultado em arquivo.html.
<P></P>
<DT><CODE>txt2tags -t html -o - arquivo.t2t</CODE></DT><DD>
<P></P>
Converte para HTML, mandando o resultado para STDOUT.
<P></P>
<DT><CODE>txt2tags -t html --toc arquivo.t2t</CODE></DT><DD>
<P></P>
Converte para HTML, com Sumário automático (Table Of Contents).
<P></P>
<DT><CODE>txt2tags -t html --toc --toc-level 2 -n arquivo.t2t</CODE></DT><DD>
<P></P>
Converte para HTML, com Sumário de dois níveis e títulos numerados.
<P></P>
<DT><CODE>txt2tags --toc-only arquivo.t2t</CODE></DT><DD>
<P></P>
Apenas mostra o Sumário, nenhuma conversão é feita.
<P></P>
<DT><CODE>txt2tags -t html --css-sugar --style base.css --style ui.css arquivo.t2t</CODE></DT><DD>
<P></P>
Converte para HTML, com código preparado para usar CSS e também inclui dois arquivos CSS externos.
<P></P>
<DT><CODE>txt2tags -t art --slides --width 80 --height 25 -o - arquivo.t2t | more</CODE></DT><DD>
<P></P>
Cria uma apresentação de slides em ASCII Art, pronta para ser mostrada em um terminal de tamanho 80x25 (colunas e linhas).
<P></P>
<DT><CODE>(echo ; echo "**bold**") | txt2tags -t html -H -</CODE></DT><DD>
<P></P>
Mostra como testar o programa rapidamente usando a STDIN como fonte.
<P></P>
<DT><CODE>txt2tags -t html -o - arquivo.t2t | tidy &gt; arquivo.html</CODE></DT><DD>
<P></P>
Manda os resultados para STDOUT e refina o código gerado usando um programa externo (tidy) antes de salvar o arquivo HTML final.
</DL>

<A NAME="arquivos"></A>
<H1>ARQUIVOS</H1>

<DL>
<DT>~/.txt2tagsrc</DT><DD>
A localização padrão para o arquivo com as configurações do usuário.
</DL>

<A NAME="ambiente"></A>
<H1>AMBIENTE</H1>

<DL>
<DT>T2TCONFIG</DT><DD>
Se definida, esta variável guarda o caminho completo para o arquivo de configuração do usuário.
</DL>

<A NAME="autor"></A>
<H1>AUTOR</H1>

<P>
Aurélio Marinho Jargas &lt;&lt;verde (a) aurelio net&gt;&gt;
</P>
<P>
Já trabalharam neste manual José Inácio Coelho &lt;&lt;jic (a) technologist com&gt;&gt; e Mauricio Teixeira &lt;&lt;mteixeira (a) webset net&gt;&gt;.
</P>

<A NAME="bugs"></A>
<H1>BUGS</H1>

<P>
<A HREF="http://bugs.txt2tags.org">http://bugs.txt2tags.org</A>
</P>

<A NAME="copyright"></A>
<H1>COPYRIGHT</H1>

<P>
Copyright (C) 2001-2010 Aurelio Jargas, GNU GPL v2
</P>

<!-- html code generated by txt2tags 2.6 (http://txt2tags.org) -->
<!-- cmdline: txt2tags -t html doc/Portuguese/manpage-pt.t2t -->
</BODY></HTML>
